v2 Getting Started (AWS)#606
Conversation
The concepts behind this draft: 1. Design paths for the main LocalStack use cases 2. Simplify the quickstart to get them to success faster 3. Have both an awslocal and a terraform quickstart 4. Bring AI and agent use cases up front [DOC-12](https://linear.app/localstack/issue/DOC-12/docs-quickstart-v2)
remotesynth
requested review from
HarshCasper and
quetzalliwrites
as code owners
Deploying localstack-docs with
|
| Latest commit: |
7773ad1
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://b0d660bf.localstack-docs.pages.dev |
| Branch Preview URL: | https://revise-getting-started.localstack-docs.pages.dev |
|
added |
Fixed some issues on the quick start and reordered the pages to make a more logical order
This was per the suggestion of Colin
peter-smith-phd
left a comment
peter-smith-phd
left a comment
There was a problem hiding this comment.
Thanks for sharing this PR. It's really nice to see the focus of Local, CI, and AI, and the working example is the perfect size to get something up and running in 10 minutes.
But, I think there's more trimming to be done. There's still a lot of complexity in these pages that go beyond "Getting Started". It'd suggest you document the happy path for the common case, and just hyperlink to the more advanced pages for more detail. If we can't get the happy path working well, then we need to fix the software to make it work better.
PR Audit SummaryStatus: Needs Significant ReworkThis PR introduces several critical technical inaccuracies, broken code snippets, and information architectural redundancies. To maintain our technical integrity and avoid introducing "docs debt," the following must be addressed before merging. Technical & Architectural Requirements1) Technical Accuracy (High Priority)
2) Code Integrity (Blockers):All code blocks must be validated and "copy-paste ready" before deployment.
3) Documentation Information Architecture (DRY Principles):
4) Editorial Standards:
Why this is necessary:We are holding this PR to ensure the "Getting Started" experience (the most high-traffic area of our site) is technically accurate and the information architecture is consistent. Merging in the current state would introduce immediate technical debt and user friction. |
Information Architecture Realignment: Removing Quickstart Anti-PatternAs part of the v2 Getting Started experience, I am realigning our information architecture (and sidebar hierarchy) to resolve a long-standing architectural anti-pattern: housing a specific Quickstart tutorial within the general "Getting Started" folder. Rationale for the Restructure:
Action Taken: I am stripping the "Quickstart" branding from the "Local Development" page and reframing it as a declarative guide for deploying your first local serverless API. This ensures the folder remains a cohesive onboarding path, while the upcoming Quickstart Library will serve as the dedicated home for specialized, multi-language recipes. |
quetzalliwrites
changed the title
The reference to the k8 tutorial has been moved into a standard Note component. This file is now dead code.
Removed redundant "Next Steps" clutter and relocated Docker, Compose, and Helm to a dedicated orchestration section. Standardized tone and corrected tool categorizations.
Consolidated use cases, removed duplicated MCP configuration, and deleted non-functional validation content. Standardized the tone and improved technical context throughout the guide.
Yes, I think that's a fair assumption. There was some back and forth on this PR partly because lstk wasn't the default, which complicated the story a bit. Now that it will be, we've been able to agree on a path forward for the PR. @quetzalliwrites is working on some revisions but is OOO until Tuesday. |
1. Rearranged the items on the index page to match the order in the nav (i.e. moved auth token) 2. Moved LocalStack CLI in the tooling section lower and marked it as deprecated (previously added the install instructions back to this page). 3. Changed the title of the lstk page to lstk CLI to make it clear the purpose as I was concerned folks looking for the CLI would gravitate to the old page. 4. Added details on the quick setup for AI (i.e. the landing page and agents.md) to the AI getting started page. 5. Added the install wizard instructions for the MCP to the getting started and the MCP page.
|
12 links failing in build, let's fix these... |
…n, while retaining core value
|
Adding the |
remotesynth
requested review from
aidehn,
alexrashed,
anisaoshafi,
baermat,
bentsku,
giograno,
k-a-il,
pinzon,
silv-io,
steffyP and
viren-nadkarni
as code owners
|
Updated from main and resolved merge conflicts: Files resolved
Additional fixes
|
The local development quick start builds upon the getting started steps, which required some updates to those steps. This is not complete yet.
Updated the function code as well to ensure the quick start had an easy payload to copy/paste.
Finessing the steps and adding necessary screenshots.
Resolve SSO sidebar conflict by keeping main's SCIM nested nav alongside explicit SSO and Azure AD entries. Co-authored-by: Cursor <cursoragent@cursor.com>
5 participants
This PR is still in early draft form.
The concepts behind this draft:
DOC-12